<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Aquamat: Dokumentacja pliku alarms.c</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Wygenerowano przez Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Strona&nbsp;główna</span></a></li>
      <li><a href="pages.html"><span>Dodatkowe&nbsp;strony</span></a></li>
      <li><a href="annotated.html"><span>Struktury&nbsp;Danych</span></a></li>
      <li class="current"><a href="files.html"><span>Pliki</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>Lista&nbsp;plików</span></a></li>
      <li><a href="globals.html"><span>Globalne</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Dokumentacja pliku alarms.c</h1><h3>(r58/r57)</h3>
<p>Implementacja interfejsu alarmowego.  
<a href="#_details">Więcej...</a></p>
<code>#include &quot;<a class="el" href="aquamat_8h_source.html">aquamat.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="alarms_8h_source.html">alarms.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="commonDefs_8h_source.html">commonDefs.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="temp_8h_source.html">temp.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="usart_8h_source.html">usart.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="strings_8h_source.html">strings.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="log_8h_source.html">log.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="hd44780_8h_source.html">hd44780.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Funkcje</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#aa31ae990ea18d273521df7b2ef62795a">alarms_is_active</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a0f01f7a8d6a94005cc8d54aeb030fc00">alarms_notification_enabled</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a10c635bae4624cbd2b36ca6fa5591e13">alarms_block_notification</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a2c73633b583ad36c667bfd1be7e2b054">alarmLog</a> (uint8_t flag, uint8_t new_state, uint8_t event_type, uint8_t id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a07c56356bed35c0ec8c873ad6d8352a3">alarms_clear</a> (void)</td></tr>
<tr><td colspan="2"><h2>Zmienne</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a71da36e3de8361e62dd7c46d28683c43">alarms_flags</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarms_8c.html#a84ac80ece697dc48e90134a685d4145e">alarms_disable_notification_counter</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Opis szczegółowy</h2>
<p>Implementacja interfejsu alarmowego. </p>
<p>Czy dany alarm jest aktywny określa wartość flagi w zmiennej <a class="el" href="alarms_8h.html#a71da36e3de8361e62dd7c46d28683c43">alarms_flags</a>. Jeżeli zmienna <a class="el" href="alarms_8h.html#a84ac80ece697dc48e90134a685d4145e">alarms_disable_notification_counter</a> jest większa od <a class="el" href="alarms_8h.html#ae9d49b88ce127c466a0cdde1f0995a52">ALARM_DISABLE_NOTIFICATION_COUNTER_VALUE</a> powiadomienie o alarmach jest odblokowane. Ta funkcjonalność umożliwia tymczasową blokadę powiadomień, np. wyłączając mruganie wyświetlacza, bądź wyłaczenie sygnalizacji dźwiękowej. </p>
<hr/><h2>Dokumentacja funkcji</h2>
<a class="anchor" id="a2c73633b583ad36c667bfd1be7e2b054"></a><!-- doxytag: member="alarms.c::alarmLog" ref="a2c73633b583ad36c667bfd1be7e2b054" args="(uint8_t flag, uint8_t new_state, uint8_t event_type, uint8_t id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void alarmLog </td>
          <td>(</td>
          <td class="paramtype">uint8_t&nbsp;</td>
          <td class="paramname"> <em>flag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&nbsp;</td>
          <td class="paramname"> <em>new_state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&nbsp;</td>
          <td class="paramname"> <em>event_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Ustawia bądź czyści alarm. </p>
<dl><dt><b>Parametry:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>flag</em>&nbsp;</td><td>wskazuje jaki alarm ustawić </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>new_state</em>&nbsp;</td><td>określa czy zdarzenie się kończy czy rozpoczyna ON - rozpoczyna, OFF - kończy Ustawia bądź czyści alarm. Dodatkowo dokonuje odpowiedniego wpisu w logu systemowym. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>flag</em>&nbsp;</td><td>wskazuje jaki alarm ustawić </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>new_state</em>&nbsp;</td><td>określa czy zdarzenie się kończy czy rozpoczyna ON - rozpoczyna, OFF - kończy </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>event_type</em>&nbsp;</td><td>typ zdarzenia, jaki trzeba wpisać do logu. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>identyfikator urządzenia wywołujacego alarm </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a10c635bae4624cbd2b36ca6fa5591e13"></a><!-- doxytag: member="alarms.c::alarms_block_notification" ref="a10c635bae4624cbd2b36ca6fa5591e13" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void alarms_block_notification </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Blokuje powiadomienia. </p>

</div>
</div>
<a class="anchor" id="a07c56356bed35c0ec8c873ad6d8352a3"></a><!-- doxytag: member="alarms.c::alarms_clear" ref="a07c56356bed35c0ec8c873ad6d8352a3" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void alarms_clear </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Czyści flagi alarmów </p>

</div>
</div>
<a class="anchor" id="aa31ae990ea18d273521df7b2ef62795a"></a><!-- doxytag: member="alarms.c::alarms_is_active" ref="aa31ae990ea18d273521df7b2ef62795a" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t alarms_is_active </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sprawdza czy aktywny jest jakikolwiek alarm. </p>
<dl class="return"><dt><b>Zwraca:</b></dt><dd>TRUE - alarm aktywny, FALSE - alarmy nieaktywny </dd></dl>

</div>
</div>
<a class="anchor" id="a0f01f7a8d6a94005cc8d54aeb030fc00"></a><!-- doxytag: member="alarms.c::alarms_notification_enabled" ref="a0f01f7a8d6a94005cc8d54aeb030fc00" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t alarms_notification_enabled </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sprawdza czy odblokowane są powiadomienia o alarmach. </p>
<dl class="return"><dt><b>Zwraca:</b></dt><dd>TRUE - powiadomiena odblokowane, FALSE - powiadomienia zablokowane </dd></dl>

</div>
</div>
<hr/><h2>Dokumentacja zmiennych</h2>
<a class="anchor" id="a84ac80ece697dc48e90134a685d4145e"></a><!-- doxytag: member="alarms.c::alarms_disable_notification_counter" ref="a84ac80ece697dc48e90134a685d4145e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t <a class="el" href="alarms_8h.html#a84ac80ece697dc48e90134a685d4145e">alarms_disable_notification_counter</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Zmienna przechowuje licznik zablokowania powiadomienia o alarmie. </p>

</div>
</div>
<a class="anchor" id="a71da36e3de8361e62dd7c46d28683c43"></a><!-- doxytag: member="alarms.c::alarms_flags" ref="a71da36e3de8361e62dd7c46d28683c43" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t <a class="el" href="alarms_8h.html#a71da36e3de8361e62dd7c46d28683c43">alarms_flags</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Zmienna przechowująca flagi alarmów. </p>
<div class="fragment"><pre class="fragment">
    76543210   - numer bitu
           X   - ALARM_FLAG_TEMP_MAX
          X    - ALARM_FLAG_TEMP_MIN
         X     - ALARM_FLAG_TEMP_SENSOR_FAILURE
        X      - ALARM_FLAG_MIN_RO
       X       - ALARM_FLAG_TOP_OFF_MAX_RUN
	</pre></div> 
</div>
</div>
</div>
<hr size="1">
<div style="text-align: center;">
<small>Projekt udostępniony jest na zasadach Open Source. Zapoznaj się z warunkami licencji w pliku COPYING znajdujacym się w katalogu głównym.	</small>
</div>

<hr size="1">
<div style="text-align: center;">
Aquamat - sterownik akwarystyczny Open Source
<br/>
Copyright (C) 2009  <a href="http://todryk.pl">Wojciech Todryk</a> (wojciech(at)todryk(dot)pl)
</div>

<div style="text-align: right;">
<small>Dokumentację wygenerowano za pomocą programu&nbsp;</small>
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
<small> wersja 1.6.1 (Fri Apr 23 22:48:16 2010)&nbsp;</small>
</div>
